Skip to content

feat: update search_users method to return UsersDTO and total count #181

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Open
wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

feat: update search_users method to return UsersDTO and total count #181

wants to merge 1 commit into from

Conversation

prakashchoudhary07
Copy link
Contributor

@prakashchoudhary07 prakashchoudhary07 commented Jul 17, 2025 •
edited by korbit-ai bot
Loading

Date:

Developer Name:

Issue Ticket Number

Description

Documentation Updated?

  • Yes
  • No

Under Feature Flag

  • Yes
  • No

Database Changes

  • Yes
  • No

Breaking Changes

  • Yes
  • No

Development Tested?

  • Yes
  • No

Screenshots

Screenshot 1

Test Coverage

Screenshot 1

Additional Notes

Description by Korbit AI

What change is being made?

Update the search_users method to return a list of UsersDTO and total count directly, and modify the user view to accommodate this change.

Why are these changes being made?

These changes streamline the process by ensuring that search_users returns data in the required Data Transfer Object (DTO) format, reducing redundancy in the views layer and enhancing code efficiency and clarity. This approach follows best practices for structuring APIs, providing a cleaner separation of concerns between data retrieval and presentation.

Is this description stale? Ask me to generate a new description by commenting /korbit-generate-pr-description

@coderabbitai coderabbitai
Copy link

coderabbitai bot commented Jul 17, 2025 •
edited
Loading

Summary by CodeRabbit

  • Refactor
    • Updated user search results to return simplified user data containing only user IDs and names.
    • Adjusted response structure for user search to reflect the updated user data format.

Walkthrough

The search_users method in UserService was updated to return a list of UsersDTO objects instead of UserModel instances, transforming the data to include only id and name. Correspondingly, the user view was modified to pass the user list directly to the response DTO without additional conversion.

Changes

File(s) Change Summary
todo/services/user_service.py Changed search_users to return List[UsersDTO] instead of List[UserModel], transforming output.
todo/views/user.py Updated to pass users directly to UserSearchResponseDTO without explicit DTO conversion.

Sequence Diagram(s)

sequenceDiagram
    participant Client
    participant UserView
    participant UserService
    participant UserRepository

    Client->>UserView: search_users(query, page, limit)
    UserView->>UserService: search_users(query, page, limit)
    UserService->>UserRepository: search_users(query, page, limit)
    UserRepository-->>UserService: [UserModel], total_count
    UserService-->>UserView: [UsersDTO], total_count
    UserView-->>Client: UserSearchResponseDTO([UsersDTO], total_count)
Loading

Possibly related PRs

  • feat: search users #129: Introduced the initial search_users method in UserService and related DTOs and views; this PR refines that functionality.
  • Get all users api #179: Added the UsersDTO class and a get_all_users method; related through the use of UsersDTO but focuses on different methods.

Suggested reviewers

  • iamitprakash

Poem

In the warren of code, a hop and a leap,
UserModels transformed, their details now deep.
With DTOs crisp, the search is now bright,
Only names and IDs, returned just right.
🐇✨
A rabbit's delight in each data byte!

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: ASSERTIVE
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 2a36d8b and 87a59a3.

📒 Files selected for processing (2)
  • todo/services/user_service.py (1 hunks)
  • todo/views/user.py (1 hunks)
🧰 Additional context used
🧠 Learnings (2)
📓 Common learnings 
Learnt from: Achintya-Chatterjee
PR: Real-Dev-Squad/todo-backend#52
File: todo/views/task.py:106-106
Timestamp: 2025-05-29T21:36:27.694Z
Learning: Issue #26 in the Real-Dev-Squad/todo-backend repository comprehensively tracks user authentication implementation including registration, login, JWT tokens, and making task APIs require authentication. This covers replacing hardcoded user ID placeholders like "system_patch_user" with actual user ID extraction from authenticated requests.

Learnt from: shobhan-sundar-goutam
PR: Real-Dev-Squad/todo-backend#95
File: todo/services/label_service.py:86-91
Timestamp: 2025-07-02T18:44:05.550Z
Learning: In the Real-Dev-Squad/todo-backend project, the GET v1/labels endpoint is designed to return only three fields in the response: id, name, and color. The prepare_label_dto method in todo/services/label_service.py intentionally excludes other LabelDTO fields like createdAt, updatedAt, createdBy, and updatedBy from the API response.
todo/views/user.py (1) 
Learnt from: shobhan-sundar-goutam
PR: Real-Dev-Squad/todo-backend#95
File: todo/services/label_service.py:86-91
Timestamp: 2025-07-02T18:44:05.550Z
Learning: In the Real-Dev-Squad/todo-backend project, the GET v1/labels endpoint is designed to return only three fields in the response: id, name, and color. The prepare_label_dto method in todo/services/label_service.py intentionally excludes other LabelDTO fields like createdAt, updatedAt, createdBy, and updatedBy from the API response.
🧬 Code Graph Analysis (1)
todo/services/user_service.py (2)
todo/repositories/user_repository.py (2)
  • search_users (78-90)
  • UserRepository (13-102)
todo/dto/user_dto.py (1)
  • UsersDTO (21-23)
🔇 Additional comments (3)
todo/services/user_service.py (2)

32-32: LGTM: Method signature updated correctly.

The return type annotation has been properly updated to reflect that the method now returns UsersDTO objects instead of raw UserModel instances. This change aligns with the architectural principle of data transformation happening in the service layer.

38-46: LGTM: Clean data transformation implementation.

The implementation correctly transforms UserModel instances to UsersDTO objects, exposing only the necessary fields (id and name) for the search functionality. This approach:

  1. Maintains consistency with the get_all_users method (lines 135-148)
  2. Follows the established pattern in the codebase of returning minimal user data for search/listing operations
  3. Properly handles the string conversion of the user ID

The data transformation is appropriately placed in the service layer, reducing coupling between the view and model layers.

todo/views/user.py (1)

110-110: LGTM: Simplified view layer after service layer refactoring.

The view now correctly passes the users list directly to UserSearchResponseDTO without additional transformation, which is appropriate since the service layer (UserService.search_users) now returns UsersDTO objects instead of raw UserModel instances. This change:

  1. Eliminates redundant data transformation in the view layer
  2. Maintains the same API contract for consumers
  3. Follows the architectural principle of keeping views thin and focused on HTTP concerns

The modification is consistent with the service layer changes and maintains proper separation of concerns.

✨ Finishing Touches
  • 📝 Generate Docstrings

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share
🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>, please review it.
    • Explain this complex logic.
    • Open a follow-up GitHub issue for this discussion.
  • Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
    • @coderabbitai explain this code block.
    • @coderabbitai modularize this function.
  • PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
    • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
    • @coderabbitai read src/utils.ts and explain its main purpose.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
    • @coderabbitai help me debug CodeRabbit configuration file.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

  • @coderabbitai pause to pause the reviews on a PR.
  • @coderabbitai resume to resume the paused reviews.
  • @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai full review to do a full review from scratch and review all the files again.
  • @coderabbitai summary to regenerate the summary of the PR.
  • @coderabbitai generate docstrings to generate docstrings for this PR.
  • @coderabbitai generate sequence diagram to generate a sequence diagram of the changes in this PR.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
  • @coderabbitai help to get help.

Other keywords and placeholders

  • Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
  • Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
  • Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • Please see the configuration documentation for more information.
  • If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

  • Visit our Documentation for detailed information on how to use CodeRabbit.
  • Join our Discord Community to get help, request features, and share feedback.
  • Follow us on X/Twitter for updates and announcements.

korbit-ai[bot]
korbit-ai bot reviewed Jul 17, 2025
View reviewed changes
Copy link

@korbit-ai korbit-ai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've completed my review and didn't find any issues... but I did find this bunny.

(\(\
( -.-)
o_(")(")
Files scanned ​
File Path Reviewed
todo/views/user.py ✅
todo/services/user_service.py ✅

Explore our documentation to understand the languages and file types we support and the files we ignore.

Check out our docs on how you can make Korbit work best for you and your team.

Loving Korbit!? Share us on LinkedIn Reddit and X

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers
1 more reviewer

@korbit-ai korbit-ai[bot] korbit-ai[bot] left review comments

Reviewers whose approvals may not affect merge requirements

At least 2 approving reviews are required to merge this pull request.

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
1 participant
@prakashchoudhary07